<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2010 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except<a name="line.4"></a>
<span class="sourceLineNo">005</span> * in compliance with the License. You may obtain a copy of the License at<a name="line.5"></a>
<span class="sourceLineNo">006</span> *<a name="line.6"></a>
<span class="sourceLineNo">007</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * Unless required by applicable law or agreed to in writing, software distributed under the License<a name="line.9"></a>
<span class="sourceLineNo">010</span> * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express<a name="line.10"></a>
<span class="sourceLineNo">011</span> * or implied. See the License for the specific language governing permissions and limitations under<a name="line.11"></a>
<span class="sourceLineNo">012</span> * the License.<a name="line.12"></a>
<span class="sourceLineNo">013</span> */<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>package com.google.common.collect;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>import static com.google.common.base.Preconditions.checkArgument;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import static com.google.common.base.Preconditions.checkNotNull;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import com.google.common.annotations.Beta;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import com.google.common.annotations.GwtCompatible;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import com.google.common.annotations.GwtIncompatible;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Collections;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.NoSuchElementException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Set;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * A sorted set of contiguous values in a given {@link DiscreteDomain}.<a name="line.29"></a>
<span class="sourceLineNo">030</span> *<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p&gt;&lt;b&gt;Warning:&lt;/b&gt; Be extremely careful what you do with conceptually large instances (such as<a name="line.31"></a>
<span class="sourceLineNo">032</span> * {@code ContiguousSet.create(Range.greaterThan(0), DiscreteDomains.integers()}). Certain<a name="line.32"></a>
<span class="sourceLineNo">033</span> * operations on such a set can be performed efficiently, but others (such as {@link Set#hashCode}<a name="line.33"></a>
<span class="sourceLineNo">034</span> * or {@link Collections#frequency}) can cause major performance problems.<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * @author Gregory Kick<a name="line.36"></a>
<span class="sourceLineNo">037</span> * @since 10.0<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span>@Beta<a name="line.39"></a>
<span class="sourceLineNo">040</span>@GwtCompatible(emulated = true)<a name="line.40"></a>
<span class="sourceLineNo">041</span>@SuppressWarnings("rawtypes") // allow ungenerified Comparable types<a name="line.41"></a>
<span class="sourceLineNo">042</span>public abstract class ContiguousSet&lt;C extends Comparable&gt; extends ImmutableSortedSet&lt;C&gt; {<a name="line.42"></a>
<span class="sourceLineNo">043</span>  /**<a name="line.43"></a>
<span class="sourceLineNo">044</span>   * Returns a {@code ContiguousSet} containing the same values in the given domain<a name="line.44"></a>
<span class="sourceLineNo">045</span>   * {@linkplain Range#contains contained} by the range.<a name="line.45"></a>
<span class="sourceLineNo">046</span>   *<a name="line.46"></a>
<span class="sourceLineNo">047</span>   * @throws IllegalArgumentException if neither range nor the domain has a lower bound, or if<a name="line.47"></a>
<span class="sourceLineNo">048</span>   *     neither has an upper bound<a name="line.48"></a>
<span class="sourceLineNo">049</span>   *<a name="line.49"></a>
<span class="sourceLineNo">050</span>   * @since 13.0<a name="line.50"></a>
<span class="sourceLineNo">051</span>   */<a name="line.51"></a>
<span class="sourceLineNo">052</span>  public static &lt;C extends Comparable&gt; ContiguousSet&lt;C&gt; create(<a name="line.52"></a>
<span class="sourceLineNo">053</span>      Range&lt;C&gt; range, DiscreteDomain&lt;C&gt; domain) {<a name="line.53"></a>
<span class="sourceLineNo">054</span>    checkNotNull(range);<a name="line.54"></a>
<span class="sourceLineNo">055</span>    checkNotNull(domain);<a name="line.55"></a>
<span class="sourceLineNo">056</span>    Range&lt;C&gt; effectiveRange = range;<a name="line.56"></a>
<span class="sourceLineNo">057</span>    try {<a name="line.57"></a>
<span class="sourceLineNo">058</span>      if (!range.hasLowerBound()) {<a name="line.58"></a>
<span class="sourceLineNo">059</span>        effectiveRange = effectiveRange.intersection(Range.atLeast(domain.minValue()));<a name="line.59"></a>
<span class="sourceLineNo">060</span>      }<a name="line.60"></a>
<span class="sourceLineNo">061</span>      if (!range.hasUpperBound()) {<a name="line.61"></a>
<span class="sourceLineNo">062</span>        effectiveRange = effectiveRange.intersection(Range.atMost(domain.maxValue()));<a name="line.62"></a>
<span class="sourceLineNo">063</span>      }<a name="line.63"></a>
<span class="sourceLineNo">064</span>    } catch (NoSuchElementException e) {<a name="line.64"></a>
<span class="sourceLineNo">065</span>      throw new IllegalArgumentException(e);<a name="line.65"></a>
<span class="sourceLineNo">066</span>    }<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span>    // Per class spec, we are allowed to throw CCE if necessary<a name="line.68"></a>
<span class="sourceLineNo">069</span>    boolean empty = effectiveRange.isEmpty()<a name="line.69"></a>
<span class="sourceLineNo">070</span>        || Range.compareOrThrow(<a name="line.70"></a>
<span class="sourceLineNo">071</span>            range.lowerBound.leastValueAbove(domain),<a name="line.71"></a>
<span class="sourceLineNo">072</span>            range.upperBound.greatestValueBelow(domain)) &gt; 0;<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span>    return empty<a name="line.74"></a>
<span class="sourceLineNo">075</span>        ? new EmptyContiguousSet&lt;C&gt;(domain)<a name="line.75"></a>
<span class="sourceLineNo">076</span>        : new RegularContiguousSet&lt;C&gt;(effectiveRange, domain);<a name="line.76"></a>
<span class="sourceLineNo">077</span>  }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span>  final DiscreteDomain&lt;C&gt; domain;<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span>  ContiguousSet(DiscreteDomain&lt;C&gt; domain) {<a name="line.81"></a>
<span class="sourceLineNo">082</span>    super(Ordering.natural());<a name="line.82"></a>
<span class="sourceLineNo">083</span>    this.domain = domain;<a name="line.83"></a>
<span class="sourceLineNo">084</span>  }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span>  @Override public ContiguousSet&lt;C&gt; headSet(C toElement) {<a name="line.86"></a>
<span class="sourceLineNo">087</span>    return headSetImpl(checkNotNull(toElement), false);<a name="line.87"></a>
<span class="sourceLineNo">088</span>  }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span>  /**<a name="line.90"></a>
<span class="sourceLineNo">091</span>   * @since 12.0<a name="line.91"></a>
<span class="sourceLineNo">092</span>   */<a name="line.92"></a>
<span class="sourceLineNo">093</span>  @GwtIncompatible("NavigableSet")<a name="line.93"></a>
<span class="sourceLineNo">094</span>  @Override public ContiguousSet&lt;C&gt; headSet(C toElement, boolean inclusive) {<a name="line.94"></a>
<span class="sourceLineNo">095</span>    return headSetImpl(checkNotNull(toElement), inclusive);<a name="line.95"></a>
<span class="sourceLineNo">096</span>  }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span>  @Override public ContiguousSet&lt;C&gt; subSet(C fromElement, C toElement) {<a name="line.98"></a>
<span class="sourceLineNo">099</span>    checkNotNull(fromElement);<a name="line.99"></a>
<span class="sourceLineNo">100</span>    checkNotNull(toElement);<a name="line.100"></a>
<span class="sourceLineNo">101</span>    checkArgument(comparator().compare(fromElement, toElement) &lt;= 0);<a name="line.101"></a>
<span class="sourceLineNo">102</span>    return subSetImpl(fromElement, true, toElement, false);<a name="line.102"></a>
<span class="sourceLineNo">103</span>  }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span>  /**<a name="line.105"></a>
<span class="sourceLineNo">106</span>   * @since 12.0<a name="line.106"></a>
<span class="sourceLineNo">107</span>   */<a name="line.107"></a>
<span class="sourceLineNo">108</span>  @GwtIncompatible("NavigableSet")<a name="line.108"></a>
<span class="sourceLineNo">109</span>  @Override public ContiguousSet&lt;C&gt; subSet(C fromElement, boolean fromInclusive, C toElement,<a name="line.109"></a>
<span class="sourceLineNo">110</span>      boolean toInclusive) {<a name="line.110"></a>
<span class="sourceLineNo">111</span>    checkNotNull(fromElement);<a name="line.111"></a>
<span class="sourceLineNo">112</span>    checkNotNull(toElement);<a name="line.112"></a>
<span class="sourceLineNo">113</span>    checkArgument(comparator().compare(fromElement, toElement) &lt;= 0);<a name="line.113"></a>
<span class="sourceLineNo">114</span>    return subSetImpl(fromElement, fromInclusive, toElement, toInclusive);<a name="line.114"></a>
<span class="sourceLineNo">115</span>  }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span>  @Override public ContiguousSet&lt;C&gt; tailSet(C fromElement) {<a name="line.117"></a>
<span class="sourceLineNo">118</span>    return tailSetImpl(checkNotNull(fromElement), true);<a name="line.118"></a>
<span class="sourceLineNo">119</span>  }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span>  /**<a name="line.121"></a>
<span class="sourceLineNo">122</span>   * @since 12.0<a name="line.122"></a>
<span class="sourceLineNo">123</span>   */<a name="line.123"></a>
<span class="sourceLineNo">124</span>  @GwtIncompatible("NavigableSet")<a name="line.124"></a>
<span class="sourceLineNo">125</span>  @Override public ContiguousSet&lt;C&gt; tailSet(C fromElement, boolean inclusive) {<a name="line.125"></a>
<span class="sourceLineNo">126</span>    return tailSetImpl(checkNotNull(fromElement), inclusive);<a name="line.126"></a>
<span class="sourceLineNo">127</span>  }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span>  /*<a name="line.129"></a>
<span class="sourceLineNo">130</span>   * These methods perform most headSet, subSet, and tailSet logic, besides parameter validation.<a name="line.130"></a>
<span class="sourceLineNo">131</span>   */<a name="line.131"></a>
<span class="sourceLineNo">132</span>  /*@Override*/ abstract ContiguousSet&lt;C&gt; headSetImpl(C toElement, boolean inclusive);<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span>  /*@Override*/ abstract ContiguousSet&lt;C&gt; subSetImpl(C fromElement, boolean fromInclusive,<a name="line.134"></a>
<span class="sourceLineNo">135</span>      C toElement, boolean toInclusive);<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span>  /*@Override*/ abstract ContiguousSet&lt;C&gt; tailSetImpl(C fromElement, boolean inclusive);<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span>  /**<a name="line.139"></a>
<span class="sourceLineNo">140</span>   * Returns the set of values that are contained in both this set and the other.<a name="line.140"></a>
<span class="sourceLineNo">141</span>   *<a name="line.141"></a>
<span class="sourceLineNo">142</span>   * &lt;p&gt;This method should always be used instead of<a name="line.142"></a>
<span class="sourceLineNo">143</span>   * {@link Sets#intersection} for {@link ContiguousSet} instances.<a name="line.143"></a>
<span class="sourceLineNo">144</span>   */<a name="line.144"></a>
<span class="sourceLineNo">145</span>  public abstract ContiguousSet&lt;C&gt; intersection(ContiguousSet&lt;C&gt; other);<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span>  /**<a name="line.147"></a>
<span class="sourceLineNo">148</span>   * Returns a range, closed on both ends, whose endpoints are the minimum and maximum values<a name="line.148"></a>
<span class="sourceLineNo">149</span>   * contained in this set.  This is equivalent to {@code range(CLOSED, CLOSED)}.<a name="line.149"></a>
<span class="sourceLineNo">150</span>   *<a name="line.150"></a>
<span class="sourceLineNo">151</span>   * @throws NoSuchElementException if this set is empty<a name="line.151"></a>
<span class="sourceLineNo">152</span>   */<a name="line.152"></a>
<span class="sourceLineNo">153</span>  public abstract Range&lt;C&gt; range();<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span>  /**<a name="line.155"></a>
<span class="sourceLineNo">156</span>   * Returns the minimal range with the given boundary types for which all values in this set are<a name="line.156"></a>
<span class="sourceLineNo">157</span>   * {@linkplain Range#contains(Comparable) contained} within the range.<a name="line.157"></a>
<span class="sourceLineNo">158</span>   *<a name="line.158"></a>
<span class="sourceLineNo">159</span>   * &lt;p&gt;Note that this method will return ranges with unbounded endpoints if {@link BoundType#OPEN}<a name="line.159"></a>
<span class="sourceLineNo">160</span>   * is requested for a domain minimum or maximum.  For example, if {@code set} was created from the<a name="line.160"></a>
<span class="sourceLineNo">161</span>   * range {@code [1..Integer.MAX_VALUE]} then {@code set.range(CLOSED, OPEN)} must return<a name="line.161"></a>
<span class="sourceLineNo">162</span>   * {@code [1..∞)}.<a name="line.162"></a>
<span class="sourceLineNo">163</span>   *<a name="line.163"></a>
<span class="sourceLineNo">164</span>   * @throws NoSuchElementException if this set is empty<a name="line.164"></a>
<span class="sourceLineNo">165</span>   */<a name="line.165"></a>
<span class="sourceLineNo">166</span>  public abstract Range&lt;C&gt; range(BoundType lowerBoundType, BoundType upperBoundType);<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span>  /** Returns a short-hand representation of the contents such as {@code "[1..100]"}. */<a name="line.168"></a>
<span class="sourceLineNo">169</span>  @Override public String toString() {<a name="line.169"></a>
<span class="sourceLineNo">170</span>    return range().toString();<a name="line.170"></a>
<span class="sourceLineNo">171</span>  }<a name="line.171"></a>
<span class="sourceLineNo">172</span>}<a name="line.172"></a>




























































</pre>
</div>
</body>
</html>
